home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 5 / Amiga Tools 5.iso / tools / dfÜ / bbs / aptbbs1 / apt / docs / acdriver.doc < prev    next >
Encoding:
Text File  |  1995-10-10  |  6.2 KB  |  185 lines

  1.  
  2. Here are some very very very, but very, brief docs on the ACDriver portion
  3. (built in) of ApT-BBS!
  4.  
  5. A dir called tplates:acd/ is used to locate one or two of the menus in my
  6. examples.  Be sure to change this if you wish for them to go to a different
  7. directory.
  8.  
  9. aptBBSMenu, acdBBSMenu, BBSText and Comments (at present) should be placed
  10. within:
  11.  
  12. APT:Config/
  13.  
  14. ---------
  15.  
  16. xxxBBSText:
  17.  
  18. These files contains all of the text (or will do!) that is used within the
  19. BBS.  They can be changed if required but be careful.
  20.  
  21. ApT allows you the ability to customize your BBS by modifying the text and
  22. menus of the system, including adding your own commands.
  23.  
  24. Using your text editor to edit BBSTEXT, you will see before you everything
  25. that the BBS displays.  You may alter this file as you wish, with these
  26. restrictions:
  27.  
  28. 1.  You must not insert or delete lines.  ApT knows what to print based on
  29. its line number in the file.  Lines length can be, however, increased
  30. within reason.  Colour codes of AML or ESCAPE nature can be inserted if
  31. required.
  32.  
  33. 2.  The "%s"'s and "%d"'s that you see throughout the file represent
  34. "formatting" commands for the BBS-where to place text strings and numbers.
  35. On any line which conatains these commands you must not alter the ORDER of
  36. these commands.
  37.  
  38. 3.  At no time may you remove or alter copyright a notice.
  39.  
  40. ----------
  41.  
  42. BBSMenu:
  43.  
  44. 1.  ApT matches command names to functions by their position in the list.
  45. The order of the menu items must NOT change.  If you want to completely
  46. REMOVE a command's function from a menu, you must CHANGE it to something
  47. Un-typeable from a command prompt, such as inserting a ^T () before the
  48. word you wish to "filter out".  DO NOT REMOVE THE LINE.
  49.  
  50. 2.  In order to match a command, the user needs only to enter the UPPERCASE
  51. portion of the command as it appears in the BBSMENU.
  52.  
  53. 3.  When at a command prompt, ApT first searches menu numbers 1 (for
  54. commands available everywhere) before any other menu.  This means that if
  55. you add a command "C" to the Main menu, it will never execute, as it will
  56. first match the "Chat" command from menu number #1
  57.  
  58. 4.  If you add your own command, you must do so at the END of the given
  59. list of commands.  In order to be functional, your command will have to
  60. make use of the special character "|" as described below.
  61.  
  62.    |     This command tells ApT that it is a USER command and that it is
  63.          to use the AML system to act out a task, be it purely of a display
  64.          purpose or the calling of a DOS, REXX, or ApT-MODULE, even the
  65.          SHOWFILE'ing of a file.
  66.  
  67.    Once the token is located everything that is displayed AFTER it is
  68.    then displayed to the screen (normally that is..) - However, after
  69.    the "|" token (at some stage in the line) there are various AML codes
  70.    that can be used to do various tasks.
  71.  
  72.    *ALL* AML codes are available here - The *ONE* difference is that the
  73.    REXX. command must have $$ following, and $$ at the end of the rexx
  74.    string to be used. As an example:
  75.  
  76.    REXX.$$'msg' getclip(_something)$$\n\n
  77.  
  78.    Would display what is inside the _something clip variable, and then
  79.    go on to display display two returns.
  80.  
  81.    By using the REXX command  is accessed by pressing ^X, it is possible
  82.    to do almost anything from loading doors/modules/scripts.. to showing
  83.    files, making decisions etc.
  84.  
  85.    Just remember that everything that comes after REXX can be the same
  86.    as the normal .apt standards of programming apt via it's rexx system. 
  87.  
  88.    to load in a module:
  89.  
  90.    REXX.$$'lockdoor' "apt:modules/nodereader"$$
  91.  
  92.    would load in the ApT Module "nodereader"
  93.  
  94.    REXX.$$'showglobalfile' "ram:test.txt"$$
  95.  
  96.    would show the ram:test.txt file to the screen
  97.  
  98.    REXX.$$'chainapt' "fish"$$
  99.  
  100.    MANY arexx commands can be put together by using the ; token
  101.    (as per standard rexx style of programming) to continue a new
  102.    command on the same line.
  103.  
  104.    REXX.$$'msg' "line 1\n";'msg' "line 2\n";'msg' "line 3\n"$$
  105.  
  106.    line 1
  107.    line 2
  108.    line 3
  109.   
  110.    would load in the aptrexx:fish.apt file as normal.
  111.  
  112.    ®     CTRL+R - Following this token is a menu-number followed by
  113.          a closing ® (^R) which tells ApT that it is to jump to a
  114.          user-defined menu. *CURRENTLY UNDER-DEVELOPMENT*
  115.  
  116.          Example,
  117.  
  118.          Going to a new menu ®25® BACK from from the menu
  119.  
  120.  
  121. List, | Loading Door!! REXX.$$'lockdoor' "apt:modules/nodereader$$\n
  122.       ^ ^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  123.       |   |            |      |      |                            |   
  124.       |   |            |      |      |                            |
  125.       |   |            |      |      |                            `- end rexx
  126.       |   |            |      |      `- Function(s)       
  127.       |   `- Text      |      |
  128.       |                |      `-- rexx code follows this.
  129.       |                |                        
  130.       |                `-- AML Power function call (non-power if %)
  131.       |
  132.       `-- Special command (PIPE)
  133.  
  134.  
  135. Every menu starts with a { which has, directly following it, the menu
  136. number.
  137.  
  138. as an example
  139.  
  140. ; comment here if required
  141. {1<return>
  142. <tab>Help<return>
  143. <tab>CHat, PAge<return>
  144. etc.
  145. }
  146.  
  147. Is the actual formula that should be used if possible.
  148.  
  149. NOTE:  Some of the fixed menus do not use the above method "always" but may
  150. be a little different.
  151.  
  152. MENUS:
  153.  
  154. menu number #1 - is the EVERYWHERE command list.  Commands here can be
  155. executed at any command prompt.  They are always scanned first before all
  156. others.
  157.  
  158. menu number #2 - is the MAIN menu from where the user starts off
  159.  
  160. menu number #3 - is the FILE menu from where the file options exist.
  161.  
  162. BBSMenu FORMAT
  163. --------------
  164.  
  165. The format of the BBSMenu numbers 2 onwards are all the same. They start
  166. off with,
  167.  
  168. line #0 = COMMENT (if required..)
  169. line #1 = the INITIATER character "{" followed by the MENU NUMBER
  170. line #2 = FULL FILENAME of the file to be displayed when ? is pressed
  171. line #3 = Command template line, giving a small command list
  172. line #4 = The command line PROMPT text (line input is entered on)
  173. line #5+ (commands)
  174. }
  175.  
  176.  
  177. COMMENTS
  178. --------
  179.  
  180. This file contains lines of comments that are read in and then displayed
  181. at the main menu, all of which are selected at random.  If the file can
  182. not be found you simply get no comment displayed, but ACDriver continues
  183. normally.
  184.  
  185.